<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<html>
<head>
<!-- Copyright 1997 The Open Group, All Rights Reserved -->
<title>chroot</title>
</head><body bgcolor=white>
<center>
<font size=2>
The Single UNIX &reg; Specification, Version 2<br>
Copyright &copy; 1997 The Open Group

</font></center><hr size=2 noshade>
<h4><a name = "tag_000_001_458">&nbsp;</a>NAME</h4><blockquote>
chroot - change root directory
(<b>LEGACY</b>)
</blockquote><h4><a name = "tag_000_001_459">&nbsp;</a>SYNOPSIS</h4><blockquote>
<pre><code>

#include &lt;<a href="unistd.h.html">unistd.h</a>&gt;

int chroot(const char *<i>path</i>);
</code>
</pre>
</blockquote><h4><a name = "tag_000_001_460">&nbsp;</a>DESCRIPTION</h4><blockquote>
The
<i>path</i>
argument points to a pathname naming a directory.
The
<i>chroot()</i>
function causes the named directory to become the root directory;
that is, the starting point for path searches for pathnames beginning
with /.
The process' working directory is unaffected by
<i>chroot()</i>.
<p>
The process must have appropriate privileges to change the root directory.
<p>
The dot-dot entry in the root directory is interpreted to mean
the root directory itself.
Thus, dot-dot cannot be used to access files outside the subtree
rooted at the root directory.
<p>
This interface need not be reentrant.
</blockquote><h4><a name = "tag_000_001_461">&nbsp;</a>RETURN VALUE</h4><blockquote>
Upon successful completion, 0 is returned.
Otherwise, -1 is returned and
<i>errno</i>
is set to indicate the error. If -1 is returned, no change is
made in the root directory.
</blockquote><h4><a name = "tag_000_001_462">&nbsp;</a>ERRORS</h4><blockquote>
The
<i>chroot()</i>
function
will fail if:
<dl compact>

<dt>[EACCES]<dd>
Search permission is denied for a component of
<i>path</i>.

<dt>[ELOOP]<dd>
Too many symbolic links were encountered in resolving <i>path</i>.

<dt>[ENAMETOOLONG]<dd>

The length of the
<i>path</i>
argument exceeds {PATH_MAX} or a pathname component is
longer than {NAME_MAX}.

<dt>[ENOENT]<dd>
A component of <i>path</i> does not name an existing directory
or <i>path</i> is an empty string.

<dt>[ENOTDIR]<dd>
A component of the <i>path</i> name is not a directory.

<dt>[EPERM]<dd>
The effective user ID does not have appropriate privileges.

</dl>
<p>
The
<i>chroot()</i>
function may fail if:
<dl compact>

<dt>[ENAMETOOLONG]<dd>

Pathname resolution of a symbolic link produced an intermediate result whose
length exceeds {PATH_MAX}.

</dl>
</blockquote><h4><a name = "tag_000_001_463">&nbsp;</a>EXAMPLES</h4><blockquote>
None.
</blockquote><h4><a name = "tag_000_001_464">&nbsp;</a>APPLICATION USAGE</h4><blockquote>
There is no portable use that an application could make of this
interface.
</blockquote><h4><a name = "tag_000_001_465">&nbsp;</a>FUTURE DIRECTIONS</h4><blockquote>
None.
</blockquote><h4><a name = "tag_000_001_466">&nbsp;</a>SEE ALSO</h4><blockquote>
<i><a href="chdir.html">chdir()</a></i>,
<i><a href="unistd.h.html">&lt;unistd.h&gt;</a></i>.
</blockquote><h4>DERIVATION</h4><blockquote>
Derived from Issue 1 of the SVID.
</blockquote><hr size=2 noshade>
<center><font size=2>
UNIX &reg; is a registered Trademark of The Open Group.<br>
Copyright &copy; 1997 The Open Group
<br> [ <a href="../index.html">Main Index</a> | <a href="../xshix.html">XSH</a> | <a href="../xcuix.html">XCU</a> | <a href="../xbdix.html">XBD</a> | <a href="../cursesix.html">XCURSES</a> | <a href="../xnsix.html">XNS</a> ]

</font></center><hr size=2 noshade>
</body></html>

